﻿//-----------------------------------------------------------------------
// <copyright file="MessageHandlerPriority.cs" company="Nathan Miller">
// Copyright (c) Nathan Miller.
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
//-----------------------------------------------------------------------
namespace TileTool.Message
{
    /// <summary>
    /// Static class which defines bounds for message handler priorities.
    /// </summary>
    public static class MessageHandlerPriority
    {
        #region Constants - Public

        /// <summary>
        /// Minimum allowable handler priority.
        /// </summary>
        public const int Min = 1;

        /// <summary>
        /// Max allowable handler priority.
        /// </summary>
        public const int Max = int.MaxValue;

        /// <summary>
        /// Default handler priority.
        /// </summary>
        public const int Default = Min;

        #endregion

        #region Methods - Public

        /// <summary>
        /// Clamp the passed priority and return the clamped value.
        /// </summary>
        /// <param name="priority">Priority value to clamp.</param>
        /// <returns>Returns the clamped priority value.</returns>
        public static int Clamp(int priority)
        {
            if (priority < Min)
            {
                return Min;
            }

            if (priority > Max)
            {
                return Max;
            }

            return priority;
        }

        #endregion
    }
}
